IRIX Base Documentation 1998 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat3 / Tk / text.z / text

Wrap

Text File | 1998-10-30 | 96KB | 1,585 lines

tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) NNNNAAAAMMMMEEEE text - Create and manipulate text widgets SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS tttteeeexxxxtttt _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s? SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS bbbbaaaacccckkkkggggrrrroooouuuunnnndddd hhhhiiiigggghhhhlllliiiigggghhhhttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd iiiinnnnsssseeeerrrrttttOOOOnnnnTTTTiiiimmmmeeee sssseeeelllleeeeccccttttBBBBoooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh| bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh hhhhiiiigggghhhhlllliiiigggghhhhttttCCCCoooolllloooorrrr iiiinnnnsssseeeerrrrttttWWWWiiiiddddtttthhhh sssseeeelllleeeeccccttttFFFFoooorrrreeeeggggrrrroooouuuunnnndddd | ccccuuuurrrrssssoooorrrr hhhhiiiigggghhhhlllliiiigggghhhhttttTTTThhhhiiiicccckkkknnnneeeessssssss ppppaaaaddddXXXX sssseeeettttGGGGrrrriiiidddd | eeeexxxxppppoooorrrrttttSSSSeeeelllleeeeccccttttiiiioooonnnn iiiinnnnsssseeeerrrrttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd ppppaaaaddddYYYY ttttaaaakkkkeeeeFFFFooooccccuuuussss | ffffoooonnnntttt iiiinnnnsssseeeerrrrttttBBBBoooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh rrrreeeelllliiiieeeeffff xxxxSSSSccccrrrroooollllllllCCCCoooommmmmmmmaaaannnndddd ffffoooorrrreeeeggggrrrroooouuuunnnndddd iiiinnnnsssseeeerrrrttttOOOOffffffffTTTTiiiimmmmeeee sssseeeelllleeeeccccttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd yyyySSSSccccrrrroooollllllllCCCCoooommmmmmmmaaaannnndddd See the ``options'' manual entry for details on the standard options. WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS Name: hhhheeeeiiiigggghhhhtttt Class: HHHHeeeeiiiigggghhhhtttt Command-Line Switch:----hhhheeeeiiiigggghhhhtttt Specifies the desired height for the window, in units of characters. Must be at least one. Name: ssssppppaaaacccciiiinnnngggg1111 | Class: SSSSppppaaaacccciiiinnnngggg1111 | Command-Line Switch:----ssssppppaaaacccciiiinnnngggg1111 | Requests additional space above each text line in the widget, using | any of the standard forms for screen distances. If a line wraps, | this option only applies to the first line on the display. This | option may be overriden with ----ssssppppaaaacccciiiinnnngggg1111 options in tags. Name: ssssppppaaaacccciiiinnnngggg2222 | Class: SSSSppppaaaacccciiiinnnngggg2222 | Command-Line Switch:----ssssppppaaaacccciiiinnnngggg2222 | For lines that wrap (so that they cover more than one line on the | display) this option specifies additional space to provide between | the display lines that represent a single line of text. The value | may have any of the standard forms for screen distances. This | option may be overriden with ----ssssppppaaaacccciiiinnnngggg2222 options in tags. Name: ssssppppaaaacccciiiinnnngggg3333 | Class: SSSSppppaaaacccciiiinnnngggg3333 | Command-Line Switch:----ssssppppaaaacccciiiinnnngggg3333 | Requests additional space below each text line in the widget, using | any of the standard forms for screen distances. If a line wraps, | this option only applies to the last line on the display. This | option may be overriden with ----ssssppppaaaacccciiiinnnngggg3333 options in tags. PPPPaaaaggggeeee 1111 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) Name: ssssttttaaaatttteeee Class: SSSSttttaaaatttteeee Command-Line Switch:----ssssttttaaaatttteeee Specifies one of two states for the text: nnnnoooorrrrmmmmaaaallll or ddddiiiissssaaaabbbblllleeeedddd. If the text is disabled then characters may not be inserted or deleted and no insertion cursor will be displayed, even if the input focus is in the widget. Name: ttttaaaabbbbssss | Class: TTTTaaaabbbbssss | Command-Line Switch:----ttttaaaabbbbssss | Specifies a set of tab stops for the window. The option's value | consists of a list of screen distances giving the positions of the | tab stops. Each position may optionally be followed in the next | list element by one of the keywords lllleeeefffftttt, rrrriiiigggghhhhtttt, cccceeeennnntttteeeerrrr, or nnnnuuuummmmeeeerrrriiiicccc,| which specifies how to justify text relative to the tab stop. LLLLeeeefffftttt | is the default; it causes the text following the tab character to be| positioned with its left edge at the tab position. RRRRiiiigggghhhhtttt means that| the right edge of the text following the tab character is positioned| at the tab position, and cccceeeennnntttteeeerrrr means that the text is centered at | the tab position. NNNNuuuummmmeeeerrrriiiicccc means that the decimal point in the text | is positioned at the tab position; if there is no decimal point | then the least significant digit of the number is positioned just to| the left of the tab position; if there is no number in the text | then the text is right-justified at the tab position. For example, | ----ttttaaaabbbbssss {{{{2222cccc lllleeeefffftttt 4444cccc 6666cccc cccceeeennnntttteeeerrrr}}}} creates three tab stops at two- | centimeter intervals; the first two use left justification and the | third uses center justification. If the list of tab stops does not | have enough elements to cover all of the tabs in a text line, then | Tk extrapolates new tab stops using the spacing and alignment from | the last tab stop in the list. The value of the ttttaaaabbbbssss option may be | overridden by ----ttttaaaabbbbssss options in tags. If no ----ttttaaaabbbbssss option is | specified, or if it is specified as an empty list, then Tk uses | default tabs spaced every eight (average size) characters. Name: wwwwiiiiddddtttthhhh Class: WWWWiiiiddddtttthhhh Command-Line Switch:----wwwwiiiiddddtttthhhh Specifies the desired width for the window in units of characters. If the font doesn't have a uniform width then the width of the character ``0'' is used in translating from character units to screen units. Name: wwwwrrrraaaapppp Class: WWWWrrrraaaapppp Command-Line Switch:----wwwwrrrraaaapppp PPPPaaaaggggeeee 2222 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) Specifies how to handle lines in the text that are too long to be displayed in a single line of the text's window. The value must be nnnnoooonnnneeee or cccchhhhaaaarrrr or wwwwoooorrrrdddd. A wrap mode of nnnnoooonnnneeee means that each line of text appears as exactly one line on the screen; extra characters that don't fit on the screen are not displayed. In the other modes each line of text will be broken up into several screen lines if necessary to keep all the characters visible. In cccchhhhaaaarrrr mode a screen line break may occur after any character; in wwwwoooorrrrdddd mode a line break will only be made at word boundaries. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN The tttteeeexxxxtttt command creates a new window (given by the _p_a_t_h_N_a_m_e argument) and makes it into a text widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the text such as its default background color and relief. The tttteeeexxxxtttt command returns the path name of the new window. A text widget displays one or more lines of text and allows that text to be edited. Text widgets support three different kinds of annotations on the text, called tags, marks, and embedded windows. Tags allow different portions of the text to be displayed with different fonts and colors. In addition, Tcl commands can be associated with tags so that scripts are invoked when particular actions such as keystrokes and mouse button presses occur in particular ranges of the text. See TAGS below for more details. The second form of annotation consists of marks, which are floating markers in the text. Marks are used to keep track of various interesting positions in the text as it is edited. See MARKS below for more details. The third form of annotation allows arbitrary windows to be embedded in a text widget. See EMBEDDED WINDOWS below for more details. IIIINNNNDDDDIIIICCCCEEEESSSS Many of the widget commands for texts take one or more indices as arguments. An index is a string used to indicate a particular place within a text, such as a place to insert characters or one endpoint of a range of characters to delete. Indices have the syntax _b_a_s_e _m_o_d_i_f_i_e_r _m_o_d_i_f_i_e_r _m_o_d_i_f_i_e_r ... Where _b_a_s_e gives a starting point and the _m_o_d_i_f_i_e_rs adjust the index from the starting point (e.g. move forward or backward one character). Every index must contain a _b_a_s_e, but the _m_o_d_i_f_i_e_rs are optional. The _b_a_s_e for an index must have one of the following forms: _l_i_n_e...._c_h_a_r Indicates _c_h_a_r'th character on line _l_i_n_e. Lines are numbered from 1 for consistency with other UNIX programs that use this numbering scheme. Within a line, characters are numbered PPPPaaaaggggeeee 3333 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) from 0. @@@@_x,,,,_y Indicates the character that covers the pixel whose x and y coordinates within the text's window are _x and _y. eeeennnndddd Indicates the end of the text (the character just after the | last newline). _m_a_r_k Indicates the character just after the mark whose name is _m_a_r_k. _t_a_g....ffffiiiirrrrsssstttt Indicates the first character in the text that has been tagged with _t_a_g. This form generates an error if no characters are currently tagged with _t_a_g. _t_a_g....llllaaaasssstttt Indicates the character just after the last one in the text that has been tagged with _t_a_g. This form generates an error if no characters are currently tagged with _t_a_g. _p_a_t_h_N_a_m_e Indicates the position of the embedded window whose name is | _p_a_t_h_N_a_m_e. This form generates an error if there is no | embedded window by the given name. If modifiers follow the base index, each one of them must have one of the forms listed below. Keywords such as cccchhhhaaaarrrrssss and wwwwoooorrrrddddeeeennnndddd may be abbreviated as long as the abbreviation is unambiguous. ++++ _c_o_u_n_t cccchhhhaaaarrrrssss Adjust the index forward by _c_o_u_n_t characters, moving to later lines in the text if necessary. If there are fewer than _c_o_u_n_t characters in the text after the current index, then set the index to the last character in the text. Spaces on either side of _c_o_u_n_t are optional. ---- _c_o_u_n_t cccchhhhaaaarrrrssss Adjust the index backward by _c_o_u_n_t characters, moving to earlier lines in the text if necessary. If there are fewer than _c_o_u_n_t characters in the text before the current index, then set the index to the first character in the text. Spaces on either side of _c_o_u_n_t are optional. ++++ _c_o_u_n_t lllliiiinnnneeeessss Adjust the index forward by _c_o_u_n_t lines, retaining the same character position within the line. If there are fewer than _c_o_u_n_t lines after the line containing the current index, then set the index to refer to the same character position on the last line of the text. Then, if the line is not long enough to contain a character at the indicated character position, adjust the character position to refer to the last character of the line (the newline). Spaces on either side of _c_o_u_n_t are optional. PPPPaaaaggggeeee 4444 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) ---- _c_o_u_n_t lllliiiinnnneeeessss Adjust the index backward by _c_o_u_n_t lines, retaining the same character position within the line. If there are fewer than _c_o_u_n_t lines before the line containing the current index, then set the index to refer to the same character position on the first line of the text. Then, if the line is not long enough to contain a character at the indicated character position, adjust the character position to refer to the last character of the line (the newline). Spaces on either side of _c_o_u_n_t are optional. lllliiiinnnneeeessssttttaaaarrrrtttt Adjust the index to refer to the first character on the line. lllliiiinnnneeeeeeeennnndddd Adjust the index to refer to the last character on the line (the newline). wwwwoooorrrrddddssssttttaaaarrrrtttt Adjust the index to refer to the first character of the word containing the current index. A word consists of any number of adjacent characters that are letters, digits, or underscores, or a single character that is not one of these. wwwwoooorrrrddddeeeennnndddd Adjust the index to refer to the character just after the last one of the word containing the current index. If the current index refers to the last character of the text then it is not modified. If more than one modifier is present then they are applied in left-to- right order. For example, the index ``eeeennnndddd ---- 1111 cccchhhhaaaarrrrssss'' refers to the next-to-last character in the text and ``iiiinnnnsssseeeerrrrtttt wwwwoooorrrrddddssssttttaaaarrrrtttt ---- 1111 cccc'' refers to the character just before the first one in the word containing the insertion cursor. TTTTAAAAGGGGSSSS The first form of annotation in text widgets is a tag. A tag is a textual string that is associated with some of the characters in a text. Tags may contain arbitrary characters, but it is probably best to avoid using the the characters `` '' (space), ++++, or ----: these characters have special meaning in indices, so tags containing them can't be used as indices. There may be any number of tags associated with characters in a text. Each tag may refer to a single character, a range of characters, or several ranges of characters. An individual character may have any number of tags associated with it. A priority order is defined among tags, and this order is used in implementing some of the tag-related functions described below. When a tag is defined (by associating it with characters or setting its display options or binding commands to it), it is given a priority higher than any existing tag. The priority order of tags may be redefined using the ``_p_a_t_h_N_a_m_e ttttaaaagggg rrrraaaaiiiisssseeee'' and ``_p_a_t_h_N_a_m_e ttttaaaagggg lllloooowwwweeeerrrr'' widget commands. PPPPaaaaggggeeee 5555 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) Tags serve three purposes in text widgets. First, they control the way information is displayed on the screen. By default, characters are displayed as determined by the bbbbaaaacccckkkkggggrrrroooouuuunnnndddd, ffffoooonnnntttt, and ffffoooorrrreeeeggggrrrroooouuuunnnndddd options for the text widget. However, display options may be associated with individual tags using the ``_p_a_t_h_N_a_m_e ttttaaaagggg ccccoooonnnnffffiiiigggguuuurrrreeee'' widget command. If a character has been tagged, then the display options associated with the tag override the default display style. The following options are currently supported for tags: ----bbbbaaaacccckkkkggggrrrroooouuuunnnndddd _c_o_l_o_r _C_o_l_o_r specifies the background color to use for characters associated with the tag. It may have any of the forms accepted by TTTTkkkk____GGGGeeeettttCCCCoooolllloooorrrr. ----bbbbggggssssttttiiiipppppppplllleeee _b_i_t_m_a_p _B_i_t_m_a_p specifies a bitmap that is used as a stipple pattern for the background. It may have any of the forms accepted by TTTTkkkk____GGGGeeeettttBBBBiiiittttmmmmaaaapppp. If _b_i_t_m_a_p hasn't been specified, or if it is specified as an empty string, then a solid fill will be used for the background. ----bbbboooorrrrddddeeeerrrrwwwwiiiiddddtttthhhh _p_i_x_e_l_s _P_i_x_e_l_s specifies the width of a 3-D border to draw around the background. It may have any of the forms accepted by TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss. This option is used in conjunction with the ----rrrreeeelllliiiieeeeffff option to give a 3-D appearance to the background for characters; it is ignored unless the ----bbbbaaaacccckkkkggggrrrroooouuuunnnndddd option has been set for the tag. ----ffffggggssssttttiiiipppppppplllleeee _b_i_t_m_a_p _B_i_t_m_a_p specifies a bitmap that is used as a stipple pattern when drawing text and other foreground information such as underlines. It may have any of the forms accepted by TTTTkkkk____GGGGeeeettttBBBBiiiittttmmmmaaaapppp. If _b_i_t_m_a_p hasn't been specified, or if it is specified as an empty string, then a solid fill will be used. ----ffffoooonnnntttt _f_o_n_t_N_a_m_e _F_o_n_t_N_a_m_e is the name of a font to use for drawing characters. It may have any of the forms accepted by TTTTkkkk____GGGGeeeettttFFFFoooonnnnttttSSSSttttrrrruuuucccctttt. ----ffffoooorrrreeeeggggrrrroooouuuunnnndddd _c_o_l_o_r _C_o_l_o_r specifies the color to use when drawing text and other foreground information such as underlines. It may have any of the forms accepted by TTTTkkkk____GGGGeeeettttCCCCoooolllloooorrrr. ----jjjjuuuussssttttiiiiffffyyyy _j_u_s_t_i_f_y If the first character of a display line has a tag for which this | option has been specified, then _j_u_s_t_i_f_y determines how to justify | the line. It must be one of lllleeeefffftttt, rrrriiiigggghhhhtttt, or cccceeeennnntttteeeerrrr. If a line | wraps, then the justification for each line on the display is | determined by the first character of that display line. PPPPaaaaggggeeee 6666 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) ----llllmmmmaaaarrrrggggiiiinnnn1111 _p_i_x_e_l_s If the first character of a text line has a tag for which this | option has been specified, then _p_i_x_e_l_s specifies how much the line | should be indented from the left edge of the window. _P_i_x_e_l_s may | have any of the standard forms for screen distances. If a line of | text wraps, this option only applies to the first line on the | display; the ----llllmmmmaaaarrrrggggiiiinnnn2222 option controls the indentation for | subsequent lines. ----llllmmmmaaaarrrrggggiiiinnnn2222 _p_i_x_e_l_s If the first character of a display line has a tag for which this | option has been specified, and if the display line is not the first | for its text line (i.e., the text line has wrapped), then _p_i_x_e_l_s | specifies how much the line should be indented from the left edge of| the window. _P_i_x_e_l_s may have any of the standard forms for screen | distances. This option is only used when wrapping is enabled, and | it only applies to the second and later display lines for a text | line. ----ooooffffffffsssseeeetttt _p_i_x_e_l_s _P_i_x_e_l_s specifies an amount by which the text's baseline should be | offset vertically from the baseline of the overall line, in pixels. | For example, a positive offset can be used for superscripts and a | negative offset can be used for subscripts. _P_i_x_e_l_s may have any of | the standard forms for screen distances. ----oooovvvveeeerrrrssssttttrrrriiiikkkkeeee _b_o_o_l_e_a_n Specifies whether or not to draw a horizontal rule through the | middle of characters. _B_o_o_l_e_a_n may have any of the forms accepted by| TTTTkkkk____GGGGeeeettttBBBBoooooooolllleeeeaaaannnn. ----rrrreeeelllliiiieeeeffff _r_e_l_i_e_f _R_e_l_i_e_f specifies the 3-D relief to use for drawing backgrounds, in any of the forms accepted by TTTTkkkk____GGGGeeeettttRRRReeeelllliiiieeeeffff. This option is used in conjunction with the ----bbbboooorrrrddddeeeerrrrwwwwiiiiddddtttthhhh option to give a 3-D appearance to the background for characters; it is ignored unless the ----bbbbaaaacccckkkkggggrrrroooouuuunnnndddd option has been set for the tag. ----rrrrmmmmaaaarrrrggggiiiinnnn _p_i_x_e_l_s If the first character of a display line has a tag for which this | option has been specified, then _p_i_x_e_l_s specifies how wide a margin | to leave between the end of the line and the right edge of the | window. _P_i_x_e_l_s may have any of the standard forms for screen | distances. This option is only used when wrapping is enabled. If a| text line wraps, the right margin for each line on the display is | determined by the first character of that display line. ----ssssppppaaaacccciiiinnnngggg1111 _p_i_x_e_l_s _P_i_x_e_l_s specifies how much additional space should be left above each| text line, using any of the standard forms for screen distances. If| a line wraps, this option only applies to the first line on the | display. PPPPaaaaggggeeee 7777 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) ----ssssppppaaaacccciiiinnnngggg2222 _p_i_x_e_l_s For lines that wrap, this option specifies how much additional space| to leave between the display lines for a single text line. _P_i_x_e_l_s | may have any of the standard forms for screen distances. ----ssssppppaaaacccciiiinnnngggg3333 _p_i_x_e_l_s _P_i_x_e_l_s specifies how much additional space should be left below each| text line, using any of the standard forms for screen distances. If| a line wraps, this option only applies to the last line on the | display. ----ttttaaaabbbbssss _t_a_b_L_i_s_t _T_a_b_L_i_s_t specifies a set of tab stops in the same form as for the | ----ttttaaaabbbbssss option for the text widget. This option only applies to a | display line if it applies to the first character on that display | line. If this option is specified as an empty string, it cancels | the option, leaving it unspecified for the tag (the default). If | the option is specified as a non-empty string that is an empty list,| such as ----ttttaaaaggggssss {{{{ }}}}, then it requests default 8-character tabs as | described for the ttttaaaaggggssss widget option. ----uuuunnnnddddeeeerrrrlllliiiinnnneeee _b_o_o_l_e_a_n _B_o_o_l_e_a_n specifies whether or not to draw an underline underneath characters. It may have any of the forms accepted by TTTTkkkk____GGGGeeeettttBBBBoooooooolllleeeeaaaannnn. ----wwwwrrrraaaapppp _m_o_d_e _M_o_d_e specifies how to handle lines that are wider than the text's | window. It has the same legal values as the ----wwwwrrrraaaapppp option for the | text widget: nnnnoooonnnneeee, cccchhhhaaaarrrr, or wwwwoooorrrrdddd. If this tag option is specified,| it overrides the ----wwwwrrrraaaapppp option for the text widget. If a character has several tags associated with it, and if their display options conflict, then the options of the highest priority tag are used. If a particular display option hasn't been specified for a particular tag, or if it is specified as an empty string, then that option will never be used; the next-highest-priority tag's option will used instead. If no tag specifies a particular display option, then the default style for the widget will be used. The second purpose for tags is event bindings. You can associate bindings with a tag in much the same way you can associate bindings with a widget class: whenever particular X events occur on characters with the given tag, a given Tcl command will be executed. Tag bindings can be used to give behaviors to ranges of characters; among other things, this allows hypertext-like features to be implemented. For details, see the description of the ttttaaaagggg bbbbiiiinnnndddd widget command below. The third use for tags is in managing the selection. See THE SELECTION below. PPPPaaaaggggeeee 8888 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) MMMMAAAARRRRKKKKSSSS The second form of annotation in text widgets is a mark. Marks are used for remembering particular places in a text. They are something like tags, in that they have names and they refer to places in the file, but a mark isn't associated with particular characters. Instead, a mark is associated with the gap between two characters. Only a single position may be associated with a mark at any given time. If the characters around a mark are deleted the mark will still remain; it will just have new neighbor characters. In contrast, if the characters containing a tag are deleted then the tag will no longer have an association with characters in the file. Marks may be manipulated with the ``_p_a_t_h_N_a_m_e mmmmaaaarrrrkkkk'' widget command, and their current locations may be determined by using the mark name as an index in widget commands. Each mark also has a _g_r_a_v_i_t_y, which is either lllleeeefffftttt or rrrriiiigggghhhhtttt. The gravity| for a mark specifies what happens to the mark when text is inserted at | the point of the mark. If a mark has left gravity, then the mark is | treated as if it were attached to the character on its left, so the mark | will remain to the left of any text inserted at the mark position. If | the mark has right gravity, new text inserted at the mark position will | appear to the right of the mark. The gravity for a mark defaults to | rrrriiiigggghhhhtttt. The name space for marks is different from that for tags: the same name may be used for both a mark and a tag, but they will refer to different things. Two marks have special significance. First, the mark iiiinnnnsssseeeerrrrtttt is associated with the insertion cursor, as described under THE INSERTION CURSOR below. Second, the mark ccccuuuurrrrrrrreeeennnntttt is associated with the character closest to the mouse and is adjusted automatically to track the mouse position and any changes to the text in the widget (one exception: ccccuuuurrrrrrrreeeennnntttt is not updated in response to mouse motions if a mouse button is down; the update will be deferred until all mouse buttons have been released). Neither of these special marks may be deleted. EEEEMMMMBBBBEEEEDDDDDDDDEEEEDDDD WWWWIIIINNNNDDDDOOOOWWWWSSSS The third form of annotation in text widgets is an embedded window. Each| embedded window annotation causes a window to be displayed at a | particular point in the text. There may be any number of embedded | windows in a text widget, and any widget may be used as an embedded | window (subject to the usual rules for geometry management, which require| the text window to be the parent of the embedded window or a descendant | of its parent). The embedded window's position on the screen will be | updated as the text is modified or scrolled, and it will be mapped and | unmapped as it moves into and out of the visible area of the text widget.| Each embedded window occupies one character's worth of index space in the| text widget, and it may be referred to either by the name of its embedded| window or by its position in the widget's index space. If the range of | text containing the embedded window is deleted then the window is | destroyed. | PPPPaaaaggggeeee 9999 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) When an embedded window is added to a text widget with the wwwwiiiinnnnddddoooowwww ccccrrrreeeeaaaatttteeee | widget command, several configuration options may be associated with it. | These options may be modified later with the wwwwiiiinnnnddddoooowwww ccccoooonnnnffffiiiigggguuuurrrreeee widget | command. The following options are currently supported: ----aaaalllliiiiggggnnnn _w_h_e_r_e If the window is not as tall as the line in which it is displayed, | this option determines where the window is displayed in the line. | _W_h_e_r_e must have one of the values ttttoooopppp (align the top of the window | with the top of the line), cccceeeennnntttteeeerrrr (center the window within the | range of the line), bbbboooottttttttoooommmm (align the bottom of the window with the | bottom of the line's area), or bbbbaaaasssseeeelllliiiinnnneeee (align the bottom of the | window with the baseline of the line). ----ccccrrrreeeeaaaatttteeee _s_c_r_i_p_t Specifies a Tcl script that may be evaluated to create the window | for the annotation. If no ----wwwwiiiinnnnddddoooowwww option has been specified for the| annotation this script will be evaluated when the annotation is | about to be displayed on the screen. _S_c_r_i_p_t must create a window | for the annotation and return the name of that window as its result.| If the annotation's window should ever be deleted, _s_c_r_i_p_t will be | evaluated again the next time the annotation is displayed. ----ppppaaaaddddxxxx _p_i_x_e_l_s _P_i_x_e_l_s specifies the amount of extra space to leave on each side of | the embedded window. It may have any of the usual forms defined for| a screen distance. ----ppppaaaaddddyyyy _p_i_x_e_l_s _P_i_x_e_l_s specifies the amount of extra space to leave on the top and | on the bottom of the embedded window. It may have any of the usual | forms defined for a screen distance. ----ssssttttrrrreeeettttcccchhhh _b_o_o_l_e_a_n If the requested height of the embedded window is less than the | height of the line in which it is displayed, this option can be used| to specify whether the window should be stretched vertically to fill| its line. If the ----ppppaaaaddddyyyy option has been specified as well, then the | requested padding will be retained even if the window is stretched. ----wwwwiiiinnnnddddoooowwww _p_a_t_h_N_a_m_e Specifies the name of a window to display in the annotation. | TTTTHHHHEEEE SSSSEEEELLLLEEEECCCCTTTTIIIIOOOONNNN Text widgets support the standard X selection. Selection support is implemented via tags. If the eeeexxxxppppoooorrrrttttSSSSeeeelllleeeeccccttttiiiioooonnnn option for the text widget is true then the sssseeeellll tag will be associated with the selection: [1] Whenever characters are tagged with sssseeeellll the text widget will claim ownership of the selection. PPPPaaaaggggeeee 11110000 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) [2] Attempts to retrieve the selection will be serviced by the text widget, returning all the characters with the sssseeeellll tag. [3] If the selection is claimed away by another application or by another window within this application, then the sssseeeellll tag will be removed from all characters in the text. The sssseeeellll tag is automatically defined when a text widget is created, and it may not be deleted with the ``_p_a_t_h_N_a_m_e ttttaaaagggg ddddeeeelllleeeetttteeee'' widget command. Furthermore, the sssseeeelllleeeeccccttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd, sssseeeelllleeeeccccttttBBBBoooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh, and sssseeeelllleeeeccccttttFFFFoooorrrreeeeggggrrrroooouuuunnnndddd options for the text widget are tied to the ----bbbbaaaacccckkkkggggrrrroooouuuunnnndddd, ----bbbboooorrrrddddeeeerrrrwwwwiiiiddddtttthhhh, and ----ffffoooorrrreeeeggggrrrroooouuuunnnndddd options for the sssseeeellll tag: changes in either will automatically be reflected in the other. TTTTHHHHEEEE IIIINNNNSSSSEEEERRRRTTTTIIIIOOOONNNN CCCCUUUURRRRSSSSOOOORRRR The mark named iiiinnnnsssseeeerrrrtttt has special significance in text widgets. It is defined automatically when a text widget is created and it may not be unset with the ``_p_a_t_h_N_a_m_e mmmmaaaarrrrkkkk uuuunnnnsssseeeetttt'' widget command. The iiiinnnnsssseeeerrrrtttt mark represents the position of the insertion cursor, and the insertion cursor will automatically be drawn at this point whenever the text widget has the input focus. WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD The tttteeeexxxxtttt command creates a new Tcl command whose name is the same as the path name of the text's window. This command may be used to invoke various operations on the widget. It has the following general form: _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...? _P_a_t_h_N_a_m_e is the name of the command, which is the same as the text widget's path name. _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the command. The following commands are possible for text widgets: _p_a_t_h_N_a_m_e bbbbbbbbooooxxxx _i_n_d_e_x Returns a list of four elements describing the screen area of the | character given by _i_n_d_e_x. The first two elements of the list give | the x and y coordinates of the upper-left corner of the area | occupied by the character, and the last two elements give the width | and height of the area. If the character is only partially visible | on the screen, then the return value reflects just the visible part.| If the character is not visible on the screen then the return value | is an empty list. _p_a_t_h_N_a_m_e ccccggggeeeetttt _o_p_t_i_o_n Returns the current value of the configuration option given by | _o_p_t_i_o_n. _O_p_t_i_o_n may have any of the values accepted by the tttteeeexxxxtttt | command. PPPPaaaaggggeeee 11111111 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) _p_a_t_h_N_a_m_e ccccoooommmmppppaaaarrrreeee _i_n_d_e_x_1 _o_p _i_n_d_e_x_2 Compares the indices given by _i_n_d_e_x_1 and _i_n_d_e_x_2 according to the relational operator given by _o_p, and returns 1 if the relationship is satisfied and 0 if it isn't. _O_p must be one of the operators <, <=, ==, >=, >, or !=. If _o_p is == then 1 is returned if the two indices refer to the same character, if _o_p is < then 1 is returned if _i_n_d_e_x_1 refers to an earlier character in the text than _i_n_d_e_x_2, and so on. _p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...? Query or modify the configuration options of the widget. If no _o_p_t_i_o_n is specified, returns a list describing all of the available options for _p_a_t_h_N_a_m_e (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the format of this list). If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no _o_p_t_i_o_n is specified). If one or more _o_p_t_i_o_n-_v_a_l_u_e pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. _O_p_t_i_o_n may have any of the values accepted by the tttteeeexxxxtttt command. _p_a_t_h_N_a_m_e ddddeeeebbbbuuuugggg ?_b_o_o_l_e_a_n? If _b_o_o_l_e_a_n is specified, then it must have one of the true or false values accepted by Tcl_GetBoolean. If the value is a true one then internal consistency checks will be turned on in the B-tree code associated with text widgets. If _b_o_o_l_e_a_n has a false value then the debugging checks will be turned off. In either case the command returns an empty string. If _b_o_o_l_e_a_n is not specified then the command returns oooonnnn or ooooffffffff to indicate whether or not debugging is turned on. There is a single debugging switch shared by all text widgets: turning debugging on or off in any widget turns it on or off for all widgets. For widgets with large amounts of text, the consistency checks may cause a noticeable slow-down. _p_a_t_h_N_a_m_e ddddeeeelllleeeetttteeee _i_n_d_e_x_1 ?_i_n_d_e_x_2? Delete a range of characters from the text. If both _i_n_d_e_x_1 and _i_n_d_e_x_2 are specified, then delete all the characters starting with the one given by _i_n_d_e_x_1 and stopping just before _i_n_d_e_x_2 (i.e. the character at _i_n_d_e_x_2 is not deleted). If _i_n_d_e_x_2 doesn't specify a position later in the text than _i_n_d_e_x_1 then no characters are deleted. If _i_n_d_e_x_2 isn't specified then the single character at _i_n_d_e_x_1 is deleted. It is not allowable to delete characters in a way that would leave the text without a newline as the last character. The command returns an empty string. _p_a_t_h_N_a_m_e ddddlllliiiinnnneeeeiiiinnnnffffoooo _i_n_d_e_x Returns a list with five elements describing the area occupied by | the display line containing _i_n_d_e_x. The first two elements of the | list give the x and y coordinates of the upper-left corner of the | area occupied by the line, the third and fourth elements give the | width and height of the area, and the fifth element gives the | PPPPaaaaggggeeee 11112222 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) position of the baseline for the line, measured down from the top of| the area. All of this information is measured in pixels. If the | current wrap mode is nnnnoooonnnneeee and the line extends beyond the boundaries| of the window, the area returned reflects the entire area of the | line, including the portions that are out of the window. If the | line is shorter than the full width of the window then the area | returned reflects just the portion of the line that is occupied by | characters and embedded windows. If the display line containing | _i_n_d_e_x is not visible on the screen then the return value is an empty| list. _p_a_t_h_N_a_m_e ggggeeeetttt _i_n_d_e_x_1 ?_i_n_d_e_x_2? Return a range of characters from the text. The return value will be all the characters in the text starting with the one whose index is _i_n_d_e_x_1 and ending just before the one whose index is _i_n_d_e_x_2 (the character at _i_n_d_e_x_2 will not be returned). If _i_n_d_e_x_2 is omitted then the single character at _i_n_d_e_x_1 is returned. If there are no characters in the specified range (e.g. _i_n_d_e_x_1 is past the end of the file or _i_n_d_e_x_2 is less than or equal to _i_n_d_e_x_1) then an empty string is returned. If the specified range contains embedded | windows, no information about them is included in the returned | string. _p_a_t_h_N_a_m_e iiiinnnnddddeeeexxxx _i_n_d_e_x Returns the position corresponding to _i_n_d_e_x in the form _l_i_n_e._c_h_a_r where _l_i_n_e is the line number and _c_h_a_r is the character number. _I_n_d_e_x may have any of the forms described under INDICES above. _p_a_t_h_N_a_m_e iiiinnnnsssseeeerrrrtttt _i_n_d_e_x _c_h_a_r_s ?_t_a_g_L_i_s_t _c_h_a_r_s _t_a_g_L_i_s_t ...? Inserts all of the _c_h_a_r_s arguments just before the character at _i_n_d_e_x. If _i_n_d_e_x refers to the end of the text (the character after | the last newline) then the new text is inserted just before the last| newline instead. If there is a single _c_h_a_r_s argument and no | _t_a_g_L_i_s_t, then the new text will receive any tags that are present on| both the character before and the character after the insertion | point; if a tag is present on only one of these characters then it | will not be applied to the new text. If _t_a_g_L_i_s_t is specified then | it consists of a list of tag names; the new characters will receive| all of the tags in this list and no others, regardless of the tags | present around the insertion point. If multiple _c_h_a_r_s-_t_a_g_L_i_s_t | argument pairs are present, they produce the same effect as if a | separate iiiinnnnsssseeeerrrrtttt widget command had been issued for each pair, in | order. The last _t_a_g_L_i_s_t argument may be omitted. _p_a_t_h_N_a_m_e mmmmaaaarrrrkkkk _o_p_t_i_o_n ?_a_r_g _a_r_g ...? This command is used to manipulate marks. The exact behavior of the command depends on the _o_p_t_i_o_n argument that follows the mmmmaaaarrrrkkkk argument. The following forms of the command are currently supported: PPPPaaaaggggeeee 11113333 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) _p_a_t_h_N_a_m_e mmmmaaaarrrrkkkk ggggrrrraaaavvvviiiittttyyyy _m_a_r_k_N_a_m_e ?_d_i_r_e_c_t_i_o_n? If _d_i_r_e_c_t_i_o_n is not specified, returns lllleeeefffftttt or rrrriiiigggghhhhtttt to | indicate which of its adjacent characters _m_a_r_k_N_a_m_e is attached | to. If _d_i_r_e_c_t_i_o_n is specified, it must be lllleeeefffftttt or rrrriiiigggghhhhtttt; the | gravity of _m_a_r_k_N_a_m_e is set to the given value. _p_a_t_h_N_a_m_e mmmmaaaarrrrkkkk nnnnaaaammmmeeeessss Returns a list whose elements are the names of all the marks that are currently set. _p_a_t_h_N_a_m_e mmmmaaaarrrrkkkk sssseeeetttt _m_a_r_k_N_a_m_e _i_n_d_e_x Sets the mark named _m_a_r_k_N_a_m_e to a position just before the character at _i_n_d_e_x. If _m_a_r_k_N_a_m_e already exists, it is moved from its old position; if it doesn't exist, a new mark is created. This command returns an empty string. _p_a_t_h_N_a_m_e mmmmaaaarrrrkkkk uuuunnnnsssseeeetttt _m_a_r_k_N_a_m_e ?_m_a_r_k_N_a_m_e _m_a_r_k_N_a_m_e ...? Remove the mark corresponding to each of the _m_a_r_k_N_a_m_e arguments. The removed marks will not be usable in indices and will not be returned by future calls to ``_p_a_t_h_N_a_m_e mmmmaaaarrrrkkkk nnnnaaaammmmeeeessss''. This command returns an empty string. _p_a_t_h_N_a_m_e ssssccccaaaannnn _o_p_t_i_o_n _a_r_g_s This command is used to implement scanning on texts. It has two forms, depending on _o_p_t_i_o_n: _p_a_t_h_N_a_m_e ssssccccaaaannnn mmmmaaaarrrrkkkk _x _y Records _x and _y and the current view in the text window, for | use in conjunction with later ssssccccaaaannnn ddddrrrraaaaggggttttoooo commands. Typically | this command is associated with a mouse button press in the | widget. It returns an empty string. _p_a_t_h_N_a_m_e ssssccccaaaannnn ddddrrrraaaaggggttttoooo _x _y This command computes the difference between its _x and _y | arguments and the _x and _y arguments to the last ssssccccaaaannnn mmmmaaaarrrrkkkk | command for the widget. It then adjusts the view by 10 times | the difference in coordinates. This command is typically associated with mouse motion events in the widget, to produce the effect of dragging the text at high speed through the window. The return value is an empty string. _p_a_t_h_N_a_m_e sssseeeeaaaarrrrcccchhhh ?_s_w_i_t_c_h_e_s? _p_a_t_t_e_r_n _i_n_d_e_x ?_s_t_o_p_I_n_d_e_x? Searches the text in _p_a_t_h_N_a_m_e starting at _i_n_d_e_x for a range of | characters that matches _p_a_t_t_e_r_n. If a match is found, the index of | the first character in the match is returned as result; otherwise | an empty string is returned. One or more of the following switches | (or abbreviations thereof) may be specified to control the search: ----ffffoooorrrrwwwwaaaarrrrddddssss The search will proceed forward through the text, finding the first matching range starting at a position later than _i_n_d_e_x. This is the default. PPPPaaaaggggeeee 11114444 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) ----bbbbaaaacccckkkkwwwwaaaarrrrddddssss The search will proceed backward through the text, finding the matching range closest to _i_n_d_e_x whose first character is before _i_n_d_e_x. ----eeeexxxxaaaacccctttt Use exact matching: the characters in the matching range must be identical to those in _p_a_t_t_e_r_n. This is the default. ----rrrreeeeggggeeeexxxxpppp Treat _p_a_t_t_e_r_n as a regular expression and match it against the text using the rules for regular expressions (see the rrrreeeeggggeeeexxxxpppp command for details). ----nnnnooooccccaaaasssseeee Ignore case differences between the pattern and the text. ----ccccoooouuuunnnntttt _v_a_r_N_a_m_e The argument following ----ccccoooouuuunnnntttt gives the name of a variable; if a match is found, the number of characters in the matching range will be stored in the variable. -------- This switch has no effect except to terminate the list of switches: the next argument will be treated as _p_a_t_t_e_r_n even if it starts with ----. The matching range must be entirely within a single line of text. For regular expression matching the newlines are removed from the ends of the lines before matching: use the $$$$ feature in regular expressions to match the end of a line. For exact matching the newlines are retained. If _s_t_o_p_I_n_d_e_x is specified, the search stops at that index: for forward searches, no match at or after _s_t_o_p_I_n_d_e_x will be considered; for backward searches, no match earlier in the text than _s_t_o_p_I_n_d_e_x will be considered. If _s_t_o_p_I_n_d_e_x is omitted, the entire text will be searched: when the beginning or end of the text is reached, the search continues at the other end until the starting location is reached again; if _s_t_o_p_I_n_d_e_x is specified, no wrap-around will occur. _p_a_t_h_N_a_m_e sssseeeeeeee _i_n_d_e_x Adjusts the view in the window so that the character given by _i_n_d_e_x | is completely visible. If _i_n_d_e_x is already visible then the command| does nothing. If _i_n_d_e_x is a short distance out of view, the command| adjusts the view just enough to make _i_n_d_e_x visible at the edge of | the window. If _i_n_d_e_x is far out of view, then the command centers | _i_n_d_e_x in the window. _p_a_t_h_N_a_m_e ttttaaaagggg _o_p_t_i_o_n ?_a_r_g _a_r_g ...? This command is used to manipulate tags. The exact behavior of the command depends on the _o_p_t_i_o_n argument that follows the ttttaaaagggg argument. The following forms of the command are currently supported: PPPPaaaaggggeeee 11115555 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) _p_a_t_h_N_a_m_e ttttaaaagggg aaaadddddddd _t_a_g_N_a_m_e _i_n_d_e_x_1 ?_i_n_d_e_x_2 _i_n_d_e_x_1 _i_n_d_e_x_2 ...? Associate the tag _t_a_g_N_a_m_e with all of the characters starting with _i_n_d_e_x_1 and ending just before _i_n_d_e_x_2 (the character at _i_n_d_e_x_2 isn't tagged). A single command may contain any number | of _i_n_d_e_x_1-_i_n_d_e_x_2 pairs. If the last _i_n_d_e_x_2 is omitted then the| single character at _i_n_d_e_x_1 is tagged. If there are no characters in the specified range (e.g. _i_n_d_e_x_1 is past the end of the file or _i_n_d_e_x_2 is less than or equal to _i_n_d_e_x_1) then the command has no effect. _p_a_t_h_N_a_m_e ttttaaaagggg bbbbiiiinnnndddd _t_a_g_N_a_m_e ?_s_e_q_u_e_n_c_e? ?_s_c_r_i_p_t? This command associates _s_c_r_i_p_t with the tag given by _t_a_g_N_a_m_e. Whenever the event sequence given by _s_e_q_u_e_n_c_e occurs for a character that has been tagged with _t_a_g_N_a_m_e, the script will be invoked. This widget command is similar to the bbbbiiiinnnndddd command except that it operates on characters in a text rather than entire widgets. See the bbbbiiiinnnndddd manual entry for complete details on the syntax of _s_e_q_u_e_n_c_e and the substitutions performed on _s_c_r_i_p_t before invoking it. If all arguments are specified then a new binding is created, replacing any existing binding for the same _s_e_q_u_e_n_c_e and _t_a_g_N_a_m_e (if the first character of _s_c_r_i_p_t is ``+'' then _s_c_r_i_p_t augments an existing binding rather than replacing it). In this case the return value is an empty string. If _s_c_r_i_p_t is omitted then the command returns the _s_c_r_i_p_t associated with _t_a_g_N_a_m_e and _s_e_q_u_e_n_c_e (an error occurs if there is no such binding). If both _s_c_r_i_p_t and _s_e_q_u_e_n_c_e are omitted then the command returns a list of all the sequences for which bindings have been defined for _t_a_g_N_a_m_e. The only events for which bindings may be specified are those related to the mouse and keyboard, such as EEEEnnnntttteeeerrrr, LLLLeeeeaaaavvvveeee, BBBBuuuuttttttttoooonnnnPPPPrrrreeeessssssss, MMMMoooottttiiiioooonnnn, and KKKKeeeeyyyyPPPPrrrreeeessssssss. Event bindings for a text widget use the ccccuuuurrrrrrrreeeennnntttt mark described under MARKS above. An | EEEEnnnntttteeeerrrr event triggers for a tag when the tag first becomes | present on the current character, and a LLLLeeeeaaaavvvveeee event triggers | for a tag when it ceases to be present on the current | character. EEEEnnnntttteeeerrrr and LLLLeeeeaaaavvvveeee events can happen either because | the ccccuuuurrrrrrrreeeennnntttt mark moved or because the character at that | position changed. Note that these events are different than | EEEEnnnntttteeeerrrr and LLLLeeeeaaaavvvveeee events for windows. Mouse and keyboard events | are directed to the current character. | It is possible for the current character to have multiple tags,| and for each of them to have a binding for a particular event | sequence. When this occurs, one binding is invoked for each | tag, in order from lowest-priority to highest priority. If | there are multiple matching bindings for a single tag, then the| most specific binding is chosen (see the manual entry for the | bbbbiiiinnnndddd command for details). ccccoooonnnnttttiiiinnnnuuuueeee and bbbbrrrreeeeaaaakkkk commands within | binding scripts are processed in the same way as for bindings | created with the bbbbiiiinnnndddd command. | PPPPaaaaggggeeee 11116666 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) If bindings are created for the widget as a whole using the | bbbbiiiinnnndddd command, then those bindings will supplement the tag | bindings. The tag bindings will be invoked first, followed by | bindings for the window as a whole. _p_a_t_h_N_a_m_e ttttaaaagggg ccccggggeeeetttt _t_a_g_N_a_m_e _o_p_t_i_o_n This command returns the current value of the option named | _o_p_t_i_o_n associated with the tag given by _t_a_g_N_a_m_e. _O_p_t_i_o_n may | have any of the values accepted by the ttttaaaagggg ccccoooonnnnffffiiiigggguuuurrrreeee widget | command. _p_a_t_h_N_a_m_e ttttaaaagggg ccccoooonnnnffffiiiigggguuuurrrreeee _t_a_g_N_a_m_e ?_o_p_t_i_o_n? ?_v_a_l_u_e? ?_o_p_t_i_o_n _v_a_l_u_e ...? This command is similar to the ccccoooonnnnffffiiiigggguuuurrrreeee widget command except that it modifies options associated with the tag given by _t_a_g_N_a_m_e instead of modifying options for the overall text widget. If no _o_p_t_i_o_n is specified, the command returns a list describing all of the available options for _t_a_g_N_a_m_e (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the format of this list). If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no _o_p_t_i_o_n is specified). If one or more _o_p_t_i_o_n-_v_a_l_u_e pairs are specified, then the command modifies the given option(s) to have the given value(s) in _t_a_g_N_a_m_e; in this case the command returns an empty string. See TAGS above for details on the options available for tags. _p_a_t_h_N_a_m_e ttttaaaagggg ddddeeeelllleeeetttteeee _t_a_g_N_a_m_e ?_t_a_g_N_a_m_e ...? Deletes all tag information for each of the _t_a_g_N_a_m_e arguments. The command removes the tags from all characters in the file and also deletes any other information associated with the tags, such as bindings and display information. The command returns an empty string. _p_a_t_h_N_a_m_e ttttaaaagggg lllloooowwwweeeerrrr _t_a_g_N_a_m_e ?_b_e_l_o_w_T_h_i_s? Changes the priority of tag _t_a_g_N_a_m_e so that it is just lower in priority than the tag whose name is _b_e_l_o_w_T_h_i_s. If _b_e_l_o_w_T_h_i_s is omitted, then _t_a_g_N_a_m_e's priority is changed to make it lowest priority of all tags. _p_a_t_h_N_a_m_e ttttaaaagggg nnnnaaaammmmeeeessss ?_i_n_d_e_x? Returns a list whose elements are the names of all the tags that are active at the character position given by _i_n_d_e_x. If _i_n_d_e_x is omitted, then the return value will describe all of the tags that exist for the text (this includes all tags that have been named in a ``_p_a_t_h_N_a_m_e ttttaaaagggg'' widget command but haven't been deleted by a ``_p_a_t_h_N_a_m_e ttttaaaagggg ddddeeeelllleeeetttteeee'' widget command, even if no characters are currently marked with the tag). The list will be sorted in order from lowest priority to highest priority. PPPPaaaaggggeeee 11117777 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) _p_a_t_h_N_a_m_e ttttaaaagggg nnnneeeexxxxttttrrrraaaannnnggggeeee _t_a_g_N_a_m_e _i_n_d_e_x_1 ?_i_n_d_e_x_2? This command searches the text for a range of characters tagged with _t_a_g_N_a_m_e where the first character of the range is no earlier than the character at _i_n_d_e_x_1 and no later than the character just before _i_n_d_e_x_2 (a range starting at _i_n_d_e_x_2 will not be considered). If several matching ranges exist, the first one is chosen. The command's return value is a list containing two elements, which are the index of the first character of the range and the index of the character just after the last one in the range. If no matching range is found then the return value is an empty string. If _i_n_d_e_x_2 is not given then it defaults to the end of the text. _p_a_t_h_N_a_m_e ttttaaaagggg rrrraaaaiiiisssseeee _t_a_g_N_a_m_e ?_a_b_o_v_e_T_h_i_s? Changes the priority of tag _t_a_g_N_a_m_e so that it is just higher in priority than the tag whose name is _a_b_o_v_e_T_h_i_s. If _a_b_o_v_e_T_h_i_s is omitted, then _t_a_g_N_a_m_e's priority is changed to make it highest priority of all tags. _p_a_t_h_N_a_m_e ttttaaaagggg rrrraaaannnnggggeeeessss _t_a_g_N_a_m_e Returns a list describing all of the ranges of text that have been tagged with _t_a_g_N_a_m_e. The first two elements of the list describe the first tagged range in the text, the next two elements describe the second range, and so on. The first element of each pair contains the index of the first character of the range, and the second element of the pair contains the index of the character just after the last one in the range. If there are no characters tagged with _t_a_g then an empty string is returned. _p_a_t_h_N_a_m_e ttttaaaagggg rrrreeeemmmmoooovvvveeee _t_a_g_N_a_m_e _i_n_d_e_x_1 ?_i_n_d_e_x_2 _i_n_d_e_x_1 _i_n_d_e_x_2 ...? Remove the tag _t_a_g_N_a_m_e from all of the characters starting at _i_n_d_e_x_1 and ending just before _i_n_d_e_x_2 (the character at _i_n_d_e_x_2 isn't affected). A single command may contain any number of | _i_n_d_e_x_1-_i_n_d_e_x_2 pairs. If the last _i_n_d_e_x_2 is omitted then the | single character at _i_n_d_e_x_1 is tagged. If there are no characters in the specified range (e.g. _i_n_d_e_x_1 is past the end of the file or _i_n_d_e_x_2 is less than or equal to _i_n_d_e_x_1) then the command has no effect. This command returns an empty string. _p_a_t_h_N_a_m_e wwwwiiiinnnnddddoooowwww _o_p_t_i_o_n ?_a_r_g _a_r_g ...? This command is used to manipulate embedded windows. The behavior | of the command depends on the _o_p_t_i_o_n argument that follows the ttttaaaagggg | argument. The following forms of the command are currently | supported: _p_a_t_h_N_a_m_e wwwwiiiinnnnddddoooowwww ccccggggeeeetttt _i_n_d_e_x _o_p_t_i_o_n Returns the value of a configuration option for an embedded window. _I_n_d_e_x identifies the embedded window, and _o_p_t_i_o_n specifies a particular configuration option, which must be one of the ones listed in the section EMBEDDED WINDOWS. PPPPaaaaggggeeee 11118888 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) _p_a_t_h_N_a_m_e wwwwiiiinnnnddddoooowwww ccccoooonnnnffffiiiigggguuuurrrreeee _i_n_d_e_x ?_o_p_t_i_o_n _v_a_l_u_e ...? Query or modify the configuration options for an embedded window. If no _o_p_t_i_o_n is specified, returns a list describing all of the available options for the embedded window at _i_n_d_e_x (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the format of this list). If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no _o_p_t_i_o_n is specified). If one or more _o_p_t_i_o_n-_v_a_l_u_e pairs are specified, then the command modifies the given option(s) to have the given value(s); in this case the command returns an empty string. See EMBEDDED WINDOWS for information on the options that are supported. _p_a_t_h_N_a_m_e wwwwiiiinnnnddddoooowwww ccccrrrreeeeaaaatttteeee _i_n_d_e_x ?_o_p_t_i_o_n _v_a_l_u_e ...? This command creates a new window annotation, which will appear in the text at the position given by _i_n_d_e_x. Any number of _o_p_t_i_o_n-_v_a_l_u_e pairs may be specified to configure the annotation. See EMBEDDED WINDOWS for information on the options that are supported. Returns an empty string. _p_a_t_h_N_a_m_e wwwwiiiinnnnddddoooowwww nnnnaaaammmmeeeessss Returns a list whose elements are the names of all windows currently embedded in _w_i_n_d_o_w. _p_a_t_h_N_a_m_e xxxxvvvviiiieeeewwww _o_p_t_i_o_n _a_r_g_s This command is used to query and change the horizontal position of the text in the widget's window. It can take any of the following forms: _p_a_t_h_N_a_m_e xxxxvvvviiiieeeewwww Returns a list containing two elements. Each element is a real fraction between 0 and 1; together they describe the portion of the document's horizontal span that is visible in the window. For example, if the first element is .2 and the second element is .6, 20% of the text is off-screen to the left, the middle 40% is visible in the window, and 40% of the text is off-screen to the right. The fractions refer only to the lines that are actually visible in the window: if the lines in the window are all very short, so that they are entirely visible, the returned fractions will be 0 and 1, even if there are other lines in the text that are much wider than the window. These are the same values passed to scrollbars via the ----xxxxssssccccrrrroooollllllllccccoooommmmmmmmaaaannnndddd option. _p_a_t_h_N_a_m_e xxxxvvvviiiieeeewwww mmmmoooovvvveeeettttoooo _f_r_a_c_t_i_o_n Adjusts the view in the window so that _f_r_a_c_t_i_o_n of the horizontal span of the text is off-screen to the left. _F_r_a_c_t_i_o_n is a fraction between 0 and 1. PPPPaaaaggggeeee 11119999 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) _p_a_t_h_N_a_m_e xxxxvvvviiiieeeewwww ssssccccrrrroooollllllll _n_u_m_b_e_r _w_h_a_t This command shifts the view in the window left or right according to _n_u_m_b_e_r and _w_h_a_t. _N_u_m_b_e_r must be an integer. _W_h_a_t must be either uuuunnnniiiittttssss or ppppaaaaggggeeeessss or an abbreviation of one of these. If _w_h_a_t is uuuunnnniiiittttssss, the view adjusts left or right by _n_u_m_b_e_r average-width characters on the display; if it is ppppaaaaggggeeeessss then the view adjusts by _n_u_m_b_e_r screenfuls. If _n_u_m_b_e_r is negative then characters farther to the left become visible; if it is positive then characters farther to the right become visible. _p_a_t_h_N_a_m_e yyyyvvvviiiieeeewwww ?_a_r_g_s? This command is used to query and change the vertical position of the text in the widget's window. It can take any of the following forms: _p_a_t_h_N_a_m_e yyyyvvvviiiieeeewwww Returns a list containing two elements, both of which are real fractions between 0 and 1. The first element gives the position of the first character in the top line in the window, relative to the text as a whole (0.5 means it is halfway through the text, for example). The second element gives the position of the character just after the last one in the bottom line of the window, relative to the text as a whole. These are the same values passed to scrollbars via the ----yyyyssssccccrrrroooollllllllccccoooommmmmmmmaaaannnndddd option. _p_a_t_h_N_a_m_e yyyyvvvviiiieeeewwww mmmmoooovvvveeeettttoooo _f_r_a_c_t_i_o_n Adjusts the view in the window so that the character given by _f_r_a_c_t_i_o_n appears on the top line of the window. _F_r_a_c_t_i_o_n is a fraction between 0 and 1; 0 indicates the first character in the text, 0.33 indicates the character one-third the way through the text, and so on. _p_a_t_h_N_a_m_e yyyyvvvviiiieeeewwww ssssccccrrrroooollllllll _n_u_m_b_e_r _w_h_a_t This command adjust the view in the window up or down according to _n_u_m_b_e_r and _w_h_a_t. _N_u_m_b_e_r must be an integer. _W_h_a_t must be either uuuunnnniiiittttssss or ppppaaaaggggeeeessss. If _w_h_a_t is uuuunnnniiiittttssss, the view adjusts up or down by _n_u_m_b_e_r lines on the display; if it is ppppaaaaggggeeeessss then the view adjusts by _n_u_m_b_e_r screenfuls. If _n_u_m_b_e_r is negative then earlier positions in the text become visible; if it is positive then later positions in the text become visible. _p_a_t_h_N_a_m_e yyyyvvvviiiieeeewwww ?----ppppiiiicccckkkkppppllllaaaacccceeee? _i_n_d_e_x Changes the view in the widget's window to make _i_n_d_e_x visible. If the ----ppppiiiicccckkkkppppllllaaaacccceeee option isn't specified then _i_n_d_e_x will appear at the top of the window. If ----ppppiiiicccckkkkppppllllaaaacccceeee is specified then the widget chooses where _i_n_d_e_x appears in the window: [1] If _i_n_d_e_x is already visible somewhere in the window then the command does nothing. PPPPaaaaggggeeee 22220000 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) [2] If _i_n_d_e_x is only a few lines off-screen above the window then it will be positioned at the top of the window. [3] If _i_n_d_e_x is only a few lines off-screen below the window then it will be positioned at the bottom of the window. [4] Otherwise, _i_n_d_e_x will be centered in the window. The ----ppppiiiicccckkkkppppllllaaaacccceeee option has been obsoleted by the sssseeeeeeee widget command (sssseeeeeeee handles both x- and y-motion to make a location visible, whereas ----ppppiiiicccckkkkppppllllaaaacccceeee only handles motion in y). _p_a_t_h_N_a_m_e yyyyvvvviiiieeeewwww _n_u_m_b_e_r This command makes the first character on the line after the one given by _n_u_m_b_e_r visible at the top of the window. _N_u_m_b_e_r must be an integer. This command used to be used for scrolling, but now it is obsolete. BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS Tk automatically creates class bindings for texts that give them the following default behavior. In the descriptions below, ``word'' refers | to a contiguous group of letters, digits, or ``_'' characters, or any | single character other than these. [1] Clicking mouse button 1 positions the insertion cursor just before the character underneath the mouse cursor, sets the input focus to this widget, and clears any selection in the widget. Dragging with mouse button 1 strokes out a selection between the insertion cursor and the character under the mouse. [2] Double-clicking with mouse button 1 selects the word under the mouse and positions the insertion cursor at the beginning of the word. Dragging after a double click will stroke out a selection consisting of whole words. [3] Triple-clicking with mouse button 1 selects the line under the mouse and positions the insertion cursor at the beginning of the line. Dragging after a triple click will stroke out a selection consisting of whole lines. [4] The ends of the selection can be adjusted by dragging with mouse button 1 while the Shift key is down; this will adjust the end of the selection that was nearest to the mouse cursor when button 1 was pressed. If the button is double-clicked before dragging then the selection will be adjusted in units of whole words; if it is triple-clicked then the selection will be adjusted in units of whole lines. [5] Clicking mouse button 1 with the Control key down will reposition the insertion cursor without affecting the selection. PPPPaaaaggggeeee 22221111 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) [6] If any normal printing characters are typed, they are inserted at the point of the insertion cursor. [7] The view in the widget can be adjusted by dragging with mouse button 2. If mouse button 2 is clicked without moving the mouse, the selection is copied into the text at the position of the insertion cursor. The Insert key also inserts the selection. [8] If the mouse is dragged out of the widget while button 1 is pressed, the entry will automatically scroll to make more text visible (if there is more text off-screen on the side where the mouse left the window). [9] The Left and Right keys move the insertion cursor one character to the left or right; they also clear any selection in the text. If Left or Right is typed with the Shift key down, then the insertion cursor moves and the selection is extended to include the new character. Control-Left and Control-Right move the insertion cursor by words, and Control-Shift-Left and Control-Shift-Right move the insertion cursor by words and also extend the selection. Control-b and Control-f behave the same as Left and Right, respectively. Meta-b and Meta-f behave the same as Control-Left and Control-Right, respectively. [10] The Up and Down keys move the insertion cursor one line up or down and clear any selection in the text. If Up or Right is typed with the Shift key down, then the insertion cursor moves and the selection is extended to include the new character. Control-Up and Control-Down move the insertion cursor by paragraphs (groups of lines separated by blank lines), and Control-Shift-Up and Control- Shift-Down move the insertion cursor by paragraphs and also extend the selection. Control-p and Control-n behave the same as Up and Down, respectively. [11] The Next and Prior keys move the insertion cursor forward or backwards by one screenful and clear any selection in the text. If the Shift key is held down while Next or Prior is typed, then the selection is extended to include the new character. Control-v moves the view down one screenful without moving the insertion cursor or adjusting the selection. [12] Control-Next and Control-Prior scroll the view right or left by one page without moving the insertion cursor or affecting the selection. [13] Home and Control-a move the insertion cursor to the beginning of its line and clear any selection in the widget. Shift-Home moves the insertion cursor to the beginning of the line and also extends the selection to that point. [14] End and Control-e move the insertion cursor to the end of the line and clear any selection in the widget. Shift-End moves the cursor to the end of the line and extends the selection to that point. PPPPaaaaggggeeee 22222222 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) [15] Control-Home and Meta-< move the insertion cursor to the beginning of the text and clear any selection in the widget. Control-Shift- Home moves the insertion cursor to the beginning of the text and also extends the selection to that point. [16] Control-End and Meta-> move the insertion cursor to the end of the text and clear any selection in the widget. Control-Shift-End moves the cursor to the end of the text and extends the selection to that point. [17] The Select key and Control-Space set the selection anchor to the position of the insertion cursor. They don't affect the current selection. Shift-Select and Control-Shift-Space adjust the selection to the current position of the insertion cursor, selecting from the anchor to the insertion cursor if there was not any selection previously. [18] Control-/ selects the entire contents of the widget. [19] Control-\ clears any selection in the widget. [20] The F16 key (labelled Copy on many Sun workstations) or Meta-w copies the selection in the widget to the clipboard, if there is a selection. [21] The F20 key (labelled Cut on many Sun workstations) or Control-w copies the selection in the widget to the clipboard and deletes the selection. If there is no selection in the widget then these keys have no effect. [22] The F18 key (labelled Paste on many Sun workstations) or Control-y inserts the contents of the clipboard at the position of the insertion cursor. [23] The Delete key deletes the selection, if there is one in the widget. If there is no selection, it deletes the character to the right of the insertion cursor. [24] Backspace and Control-h delete the selection, if there is one in the widget. If there is no selection, they delete the character to the left of the insertion cursor. [25] Control-d deletes the character to the right of the insertion cursor. [26] Meta-d deletes the word to the right of the insertion cursor. [27] Control-k deletes from the insertion cursor to the end of its line; if the insertion cursor is already at the end of a line, then Control-k deletes the newline character. PPPPaaaaggggeeee 22223333 tttteeeexxxxtttt((((3333TTTTkkkk)))) tttteeeexxxxtttt((((3333TTTTkkkk)))) [28] Control-o opens a new line by inserting a newline character in front of the insertion cursor without moving the insertion cursor. [29] Meta-backspace and Meta-Delete delete the word to the left of the insertion cursor. [30] Control-x deletes whatever is selected in the text widget. [31] Control-t reverses the order of the two characters to the right of the insertion cursor. If the widget is disabled using the ----ssssttttaaaatttteeee option, then its view can still be adjusted and text can still be selected, but no insertion cursor will be displayed and no text modifications will take place. The behavior of texts can be changed by defining new bindings for individual widgets or by redefining the class bindings. PPPPEEEERRRRFFFFOOOORRRRMMMMAAAANNNNCCCCEEEE IIIISSSSSSSSUUUUEEEESSSS Text widgets should run efficiently under a variety of conditions. The text widget uses about 2-3 bytes of main memory for each byte of text, so texts containing a megabyte or more should be practical on most workstations. Text is represented internally with a modified B-tree structure that makes operations relatively efficient even with large texts. Tags are included in the B-tree structure in a way that allows tags to span large ranges or have many disjoint smaller ranges without loss of efficiency. Marks are also implemented in a way that allows large numbers of marks. The only known mode of operation where a text widget may not run efficiently is if it has a very large number of different tags. Hundreds of tags should be fine, or even a thousand, but tens of thousands of tags will make texts consume a lot of memory and run slowly. KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS text, widget PPPPaaaaggggeeee 22224444